Amazon Pay V2

AmazonPayV2決済 API一覧

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200：常に200を返却
Request header
Content-Type: application/json;charset=UTF-8
Method
POST
Response header
Content-Type: application/json;charset=UTF-8
Status Code
  • 200：正常時
  • 400：入力パラメータエラー、加盟店設定エラー
  • 500：システムエラー
  • 502：決済エラー
　　　　　　　
    ※以下のエラーコードはhttp200で返却される可能性がございます。
    　 ・E90010001
    　 ・E92000001
    　 ・E92000002
    　 ・E91099996
    　 ・E91099997

EntryTranAmazonpay 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
OrderID orderID 必須 半角英数記号27桁
オーダーID

加盟店様が取引を識別するための値を設定します。

JobCd jobCd 必須 半角英字7桁
処理区分

AUTH：仮売上
CAPTURE：即時売上

Amount amount 必須 半角数字7桁
利用金額

Tax tax 半角数字7桁
税送料

税送料を指定した場合は、利用金額 + 税送料が決済金額となります。

AmazonpayType amazonpayType 必須 半角数字1桁
AmazonPay実装タイプ

「3」を設定してください。

URL
/payment/EntryTranAmazonpay.json
リクエストパラメータ
{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "orderID": "ORDER0000001",
    "jobCd": "AUTH",
    "amount": "1000",
    "amazonpayType": "3",
}
URL
/payment/EntryTranAmazonpay.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=AUTH&Amount=1000&AmazonpayType=3
レスポンス
正常
AccessID accessID 必須 半角英数32桁 固定
取引ID
AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード
異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813"
}
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
レスポンスパラメータ：異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

ExecTranAmazonpay 決済実行

これ以降の決済取引で必要となるトークンを返却します。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
AccessID accessID 必須 半角英数32桁 固定
取引ID

【取引登録】で発行された値を設定します。

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

【取引登録】で発行された値を設定します。

OrderID orderID 必須 半角英数記号27桁
オーダーID

【取引登録】で指定した値を設定します。

ClientField1 clientField1 全半角100バイト
加盟店自由項目1
ClientField2 clientField2 全半角100バイト
加盟店自由項目2
ClientField3 clientField3 全半角100バイト
加盟店自由項目3
RetURL retURL 必須 半角英数記号256桁
決済結果戻しURL

加盟店様が当サービスからの決済結果を受信する為の結果受信URLを設定します。
指定されたURLにブラウザのリダイレクト経由で決済結果が送信されます。

PaymentTermSec paymentTermSec 半角数字5桁
支払開始期限秒

お客様が【決済実行】から【支払手続き開始】を呼び出すまでの期限です。
最大86,400秒（1日）
呼び出しパラメータが空の場合、120秒で処理されます。

AmazonCheckoutSessionID amazonCheckoutSessionID 半角英数256桁
AmazonチェックアウトセッションID

Amazonログイン後に取得できるamazonCheckoutSessionIdを設定します。
APBを利用しない場合は必須です。

ポイント

弊社「テスト環境」では正当性チェックを行っていないため、ダミー値でも決済可能です。
※ただし、AmazonのSANDBOX環境をご利用の場合、正当性チェックが行われます。
Description Description 全半角255桁
注文の説明

注文の説明です。
Amazonからお客様へのメールに表示されます。
APBを使用する場合

各パラメータはAPBを使用する場合のみ設定してください。

ApbType apbType 半角英数10桁
APBタイプ

APB利用の場合は、以下いずれかを設定ください。

PayOnly：購入者のAmazon支払い方法のみを使用。デジタル商品など住所情報を使用しない場合に利用します。
PayAndShip：購入者のAmazon支払い方法と配送先を使用。物販など住所情報を使用する場合に利用します。

ShippingCountryCode shippingCountryCode 全半角2桁
配送先国コード

APBタイプ:PayAndShipの場合は必須
例:JP
ShippingPostalCode shippingPostalCode 半角数字記号16桁
配送先郵便番号

APBタイプ:PayAndShipの場合は必須
例:150-0043
ShippingStateOrRegion shippingStateOrRegion 全半角50バイト
配送先都道府県

APBタイプ:PayAndShipの場合は必須
UTF-8のバイト数です。
例:東京都
ShippingAddressLine1 shippingAddressLine1 全半角60バイト
配送先住所1

APBタイプ:PayAndShipの場合は必須
UTF-8のバイト数です。
例:渋谷区道玄坂3-14-6
ShippingAddressLine2 shippingAddressLine2 全半角60バイト
配送先住所2

UTF-8のバイト数です。
例:渋谷ビルディング
ShippingAddressLine3 shippingAddressLine3 全半角60バイト
配送先住所3

UTF-8のバイト数です。
例:○○株式会社
ShippingName shippingName 全半角50バイト
配送先氏名

APBタイプ:PayAndShipの場合は必須
UTF-8のバイト数です。
例：テスト 花子
ShippingPhoneNumber shippingPhoneNumber 半角数字記号13桁
配送先電話番号

APBタイプ:PayAndShipの場合は必須
例：03-0000-0001

URL
/payment/ExecTranAmazonpay.json
リクエストパラメータ
{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
    "orderID": "ORDER0000001",
    "retURL": "https://example.com/receive",
    "amazonCheckoutSessionID": "a7b5724e-ec6d-4b9a-8b64-599404b9b564"
}
リクエストパラメータ:APB利用
{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
    "orderID": "ORDER0000001",
    "retURL": "https://example.com/receive",
    "amazonCheckoutSessionID": "a7b5724e-ec6d-4b9a-8b64-599404b9b564",
    "apbType": "PayAndShip",
    "shippingCountryCode": "JP",
    "shippingPostalCode": "150-0043",
    "shippingStateOrRegion": "東京都",
    "shippingAddressLine1": "渋谷区道玄坂 3-14-6",
    "shippingAddressLine2": "渋谷ビルディング",
    "shippingAddressLine3": "○○株式会社",
    "shippingName": "テスト 花子",
    "shippingPhoneNumber": "03-0000-0001"
}
URL
/payment/ExecTranAmazonpay.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&RetURL=https://example.com/receive&AmazonCheckoutSessionID=a7b5724e-ec6d-4b9a-8b64-599404b9b564
リクエストパラメータ:APB利用
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&RetURL=https://example.com/receive&AmazonCheckoutSessionID=a7b5724e-ec6d-4b9a-8b64-599404b9b564&ApbType=PayAndShip&ShippingCountryCode=JP&ShippingPostalCode=150-0043&ShippingStateOrRegion=東京都&ShippingAddressLine1=渋谷区道玄坂 3-14-6&ShippingAddressLine2=渋谷ビルディング&ShippingAddressLine3=○○株式会社&ShippingName=テスト 花子&ShippingPhoneNumber=03-0000-0001
レスポンス
正常
AccessID accessID 必須 半角英数32桁 固定
取引ID
Token token 必須 半角英数64桁 固定
トークン

取引IDのハッシュ値を返却します。

StartURL startURL 必須
支払開始URL

支払手続き開始のURLを返却します。

StartLimitDate startLimitDate 必須 半角数字14桁 固定
支払開始期限日時

支払手続き開始の呼び出し期限を返却します。
yyyyMMddHHmmss書式

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "token": "qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL",
    "startURL": "https://x01.mul-pay.jp/payment/AmazonpayStart.idPass",
    "startLimitDate": "20190225162711"
}
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL&StartURL=https://x01.mul-pay.jp/payment/AmazonpayStart.idPass&StartLimitDate=20190225162711
レスポンスパラメータ：異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

AmazonpayStart 支払手続き開始

お客様をAmazonPay画面へ遷移させる必要があります。
当サービスのリダイレクト機能を利用して、お客様を当サービスの支払手続き開始IFに誘導してください。
※取引が特定できない場合、すでに支払いを済ませている場合等は、エラー画面を表示します。

リクエスト
AccessID 必須 半角英数32桁 固定
取引ID

【取引登録】で発行された値を設定します。
Token 必須 半角英数64桁 固定
トークン

【決済実行】で発行された値を設定します。

URL
/payment/AmazonpayStart.idPass
リダイレクトページサンプル

<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
  </head>
  <body OnLoad='OnLoadEvent();'>
    <form name="AmazonpayRedirectCall" action="{接続先URL}" method="POST">
      <noscript>
        <br>
        <br>
        <center>
          <h2>AmazonPayの決済画面へ遷移します。 </h2>
          <input type="submit" value="続行">
        </center>
      </noscript>
      <input type="hidden" name="AccessID" value="{AccessID}">
      <input type="hidden" name="Token" value="{Token}">
    </form>
    <script >
<!--
 function OnLoadEvent() {
 document.AmazonpayRedirectCall.submit();
 }
//-->
</script>
  </body>
</html>

リダイレクト後、お客様はAmazon画面へ遷移し、決済処理完了後に【決済実行】で指定された決済結果戻しURLへ自動で遷移します。

決済結果受信

Amazonでの決済処理が完了した際に、決済実行時に指定された決済結果戻しURLに結果を通知します。
この決済結果はブラウザ経由で連携されるため、ユーザの操作方法によっては決済完了したにもかかわらず、加盟店様に通知されないことがあります。
その際はショップ管理画面、結果通知、決済状態照会にてご確認ください。また、同様の理由でこの決済結果が複数回加盟店様に通知されることがあります。

レスポンス
正常
ShopID 必須 半角英数13桁
ショップID
OrderID 必須 半角英数記号27桁
オーダーID

対象取引のオーダーIDを返却します。
Status 必須
現状態

AUTH：仮売上
REQCAPTURE：即時売上受付
CAPTURE：即時売上
PAYFAIL：決済失敗

TranDate 必須 半角数字14桁 固定
処理日時

yyyyMMddHHmmss書式

AmazonChargePermissionID 必須 半角英数19桁
AmazonチャージパーミッションID

Amazonで取引を特定するためのIDを返却します。
CheckString 必須 半角英数64桁
改ざんチェック文字列

OrderID、AccessID、ShopID、ShopPass、AmazonChargePermissionIDを連結しSHA256ハッシュした値を返却します。

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード

AmazonpaySales 実売上

仮売上の決済に対して実売上を行います。実行時に仮売上時との金額チェックを行います。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
AccessID accessID 必須 半角英数32桁 固定
取引ID

【取引登録】で発行された値を設定します。

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

【取引登録】で発行された値を設定します。

OrderID orderID 必須 半角英数記号27桁
オーダーID

加盟店様が取引を識別するための値を設定します。

Amount amount 必須 半角数字7桁
利用金額

税送料を指定した場合は、利用金額 + 税送料が売上金額となります。
仮売上時の金額と一致しない場合エラーとなります。

Tax tax 半角数字7桁
税送料

税送料を指定した場合は、利用金額 + 税送料が売上金額となります。
仮売上時の金額と一致しない場合エラーとなります。

URL
/payment/AmazonpaySales.json
リクエストパラメータ
{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
    "orderID": "ORDER0000001",
    "amount": "1000"
}
URL
/payment/AmazonpaySales.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1000
レスポンス
正常
OrderID orderID 必須 半角英数記号27桁
オーダーID

対象取引のオーダーIDを返却します。

Status status 必須
現状態

REQSALES：売上受付
SALES：実売上

Amount amount 必須 半角数字7桁
利用金額

実売上した利用金額を返却します。

Tax tax 必須 半角数字7桁
税送料

実売上したを税送料を返却します。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
    "orderID": "ORDER0000001",
    "status": "SALES",
    "amount": "1000",
    "tax": "0"
}
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=SALES&Amount=1000&Tax=0
レスポンスパラメータ：異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

AmazonpayCancel キャンセル

対象の取引をキャンセルします。実売上または即時売上状態の取引は一部返金が可能です。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
AccessID accessID 必須 半角英数32桁 固定
取引ID

【取引登録】で発行された値を設定します。

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

【取引登録】で発行された値を設定します。

OrderID orderID 必須 半角英数記号27桁
オーダーID

加盟店様が取引を識別するための値を設定します。

CancelAmount cancelAmount 必須 半角数字7桁
キャンセル金額

キャンセル金額 + キャンセル税送料が処理金額となります。
対象取引が仮売上の場合、キャンセル金額・税送料は仮売上時の金額を指定してください。
対象取引が実売上または即時売上状態の場合、[1円～現在の金額]の範囲で指定が可能です。

CancelTax cancelTax 半角数字7桁
キャンセル税送料

キャンセル金額 + キャンセル税送料が処理金額となります。
対象取引が仮売上の場合、キャンセル金額・税送料は仮売上時の金額を指定してください。
対象取引が実売上または即時売上状態の場合、[1円～現在の金額]の範囲で指定が可能です。

URL
/payment/AmazonpayCancel.json
リクエストパラメータ
{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
    "orderID": "ORDER0000001",
    "cancelAmount": "1000"
}
URL
/payment/AmazonpayCancel.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&CancelAmount=1000
レスポンス
正常
OrderID orderID 必須 半角英数記号27桁
オーダーID

対象取引のオーダーIDを返却します。

Status status 必須
現状態

対象取引の取引状態を返却します。
対象取引が仮売上状態だった場合
・CANCEL：キャンセル
対象取引が実売上または即時売上状態だった場合
・REQRETURN：返品受付
・RETURN：返品
全額キャンセルでない場合、返品受付からキャンセル処理前のステータスに更新されます。

Amount amount 必須 半角数字7桁
利用金額

利用金額からキャンセル金額を減算した結果を返却します。

Tax tax 必須 半角数字7桁
税送料

税送料からキャンセル税送料を減算した結果を返却します。

CancelAmount cancelAmount 必須 半角数字7桁
キャンセル金額

リクエストしたキャンセル金額を返却します。

CancelTax cancelTax 必須 半角数字7桁
キャンセル税送料

リクエストしたキャンセル税送料を返却します。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
    "orderID": "ORDER0000001",
    "status": "CANCEL",
    "amount": "0",
    "tax": "0",
    "cancelAmount": "1000",
    "cancelTax": "0"
}
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=CANCEL&Amount=0&Tax=0&CancelAmount=1000&CancelTax=0
レスポンスパラメータ：異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

AmazonpayChange 金額変更

対象の取引の金額を変更します。仮売上状態の取引のみ可能です。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
AccessID accessID 必須 半角英数32桁 固定
取引ID

【取引登録】で発行された値を設定します。

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

【取引登録】で発行された値を設定します。

OrderID orderID 必須 半角英数記号27桁
オーダーID

加盟店様が取引を識別するための値を設定します。

Amount amount 必須 半角数字7桁
変更後金額

変更後金額 + 変更後税送料が処理金額となります。

Tax tax 半角数字7桁
変更後税送料

変更後金額 + 変更後税送料が処理金額となります。

URL
/payment/AmazonpayChange.json
リクエストパラメータ
{
    "shopID": "tshop11223344",
    "shopPass": "xxxxxxxx",
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
    "orderID": "ORDER0000001",
    "amount": "1100"
}
URL
/payment/AmazonpayChange.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=xxxxxxxx&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1100
レスポンス
正常
OrderID orderID 必須 半角英数記号27桁
オーダーID

対象取引のオーダーIDを返却します。

Status status 必須
現状態

・AUTH：仮売上

Amount amount 必須 半角数字7桁
変更後金額

変更後金額を返却します。

Tax tax 必須 半角数字7桁
変更後税送料

変更後税送料を返却します。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
    "orderID": "ORDER0000001",
    "status": "SALES",
    "amount": "1100",
    "tax": "0"
}
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=SALES&Amount=1100&Tax=0
レスポンスパラメータ：異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

SearchAddressAmazonpay 住所情報参照

対象取引に対する住所情報を取得します。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
OrderID orderID 半角英数記号27桁
オーダーID

加盟店様が取引を識別するための値を設定します。
決済が完了している場合、AmazonチェックアウトセッションID、Amazonバイヤートークンは設定せず、当パラメータを設定してください。

AmazonCheckoutSessionID amazonCheckoutSessionID 半角英数256桁
AmazonチェックアウトセッションID

Amazonログイン後に取得できるamazonCheckoutSessionIdを設定します。
決済完了前に住所情報を取得する場合、オーダーID、Amazonバイヤートークンは設定せず、当パラメータを設定してください。

AmazonBuyerToken amazonBuyerToken 半角英数1024桁
Amazonバイヤートークン

決済を伴わないAmazonログイン後に取得できるbuyerTokenを設定します。
決済手続き前に利用者のAmazonバイヤーIDなどを取得したい場合、オーダーID、AmazonチェックアウトセッションIDは設定せず、当パラメータを設定してください。

URL
/payment/SearchAddressAmazonpay.json
リクエストパラメータ
{
    "shopID": "tshop11223344",
    "shopPass": "xxxxxxxx"
    "orderID": "ORDER0000001"
}
URL
/payment/SearchAddressAmazonpay.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=xxxxxxxx&OrderID=ORDER0000001
レスポンス
正常
ShippingCountryCode shippingCountryCode 必須
配送先国コード

決済時に選択した住所の国コードを返却します。※1 ※5
例：JP

ShippingCity shippingCity 必須
配送先都市

空欄を返却します。

ShippingCounty shippingCounty 必須
配送先州・群

空欄を返却します。

ShippingDistrict shippingDistrict 必須
配送先区

空欄を返却します。

ShippingPostalCode shippingPostalCode 必須
配送先郵便番号

決済時に選択した住所の郵便番号を返却します。※1 ※5
例：150-0043

ShippingStateOrRegion shippingStateOrRegion 必須
配送先都道府県

決済時に選択した住所の都道府県を返却します。※1 ※5
例：東京都

ShippingAddressLine1 shippingAddressLine1 必須
配送先住所1

決済時に選択した住所を返却します。※1 ※5
例：渋谷区道玄坂 3-14-6

ShippingAddressLine2 shippingAddressLine2 必須
配送先住所2

決済時に選択した住所を返却します。※1 ※5
例：渋谷ビルディング

ShippingAddressLine3 shippingAddressLine3 必須
配送先住所3

決済時に選択した住所の会社名を返却します。※1 ※5
例：○○株式会社

ShippingName shippingName 必須
配送先氏名

決済時に選択した住所の氏名を返却します。※1 ※5
例：テスト 花子

ShippingPhoneNumber shippingPhoneNumber 必須
配送先電話番号

決済時に選択した住所の電話番号を返却します。※1 ※5
例：03-0000-0001

AmazonBuyerID amazonBuyerID 必須
AmazonバイヤーID

ユーザを特定するIDを返却します。Amazon出品者IDごとに一意となります。※1 ※2 ※3 ※4 ※5
例：amzn1.account.XXXXXXXXXXXXXXXXXXXXXXXXXXXX

AmazonAccountName amazonAccountName 必須
Amazonアカウント名

Amazonアカウントの氏名を返却します。※1 ※2 ※3
例：テスト 太郎

AmazonMailAddress amazonMailAddress 必須
Amazonアカウントメールアドレス

Amazonアカウントのメールアドレスを返却します。※1 ※2 ※4
例：test@example.com

BillingCountryCode billingCountryCode 必須
請求先国コード

請求先住所の国コードを返却します。※1 ※2 ※5

BillingCity billingCity 必須
請求先都市

空欄を返却します。

BillingCounty billingCounty 必須
請求先州・群

空欄を返却します。

BillingDistrict billingDistrict 必須
請求先区

空欄を返却します。

BillingPostalCode billingPostalCode 必須
請求先郵便番号

請求先住所の郵便番号を返却します。※1 ※2 ※5

BillingStateOrRegion billingStateOrRegion 必須
請求先都道府県

請求先住所の都道府県を返却します。※1 ※2 ※5

BillingAddressLine1 billingAddressLine1 必須
請求先住所1

請求先住所を返却します。※1 ※2 ※5

BillingAddressLine2 billingAddressLine2 必須
請求先住所2

請求先住所を返却します。※1 ※2 ※5

BillingAddressLine3 billingAddressLine3 必須
請求先住所3

請求先住所を返却します。※1 ※2 ※5

BillingName billingName 必須
請求先氏名

請求先住所の氏名を返却します。※1 ※2 ※5

BillingPhoneNumber billingPhoneNumber 必須
請求先電話番号

請求先住所の電話番号を返却します。※1 ※2 ※5

PaymentDescriptor paymentDescriptor 必須
支払い方法説明

固定の文字列を返却します。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード

※1 Amazon PayボタンのproductTypeがPayAndShipの場合に値を返却します。
※2 Amazon PayボタンのproductTypeがPayOnlyの場合に値を返却します。
※3 Amazon PayボタンのproductTypeがSignInでアクセス可能な情報に「氏名」がチェックされていた場合に値を返却します。
※4 Amazon PayボタンのproductTypeがSignInでアクセス可能な情報に「メールアドレス」がチェックされていた場合に値を返却します。
※5 Amazon PayボタンのproductTypeがSignInでアクセス可能な情報に「住所情報」がチェックされていた場合に値を返却します。
※エラーコード、エラー詳細コード以外の値は全てWindows-31JでURLエンコードした値を返却します。
※値が設定されていない場合もパラメータを返却します。
※請求先住所情報が返却されない場合は、弊社管理画面からAmazonPayボタン情報を取得しなおし、payload、signatureをAmazonPayボタンに反映した上で再度お試しください。

レスポンスパラメータ：正常系
{
    "shippingCountryCode": "JP",
    "shippingCity": "",
    "shippingCounty": "",
    "shippingDistrict": "",
    "shippingPostalCode": "150-0043",
    "shippingStateOrRegion": "",
    "shippingAddressLine1": "%93%B9%8C%BA%8D%E2%203-14-6",
    "shippingAddressLine2": "%83q%83%85%81%5B%83%7D%83b%83N%83X%8Fa%92J%83r%83%8B",
    "shippingAddressLine3": "",
    "shippingName": "%83e%83X%83g%20%89%D4%8Eq",
    "shippingPhoneNumber": "03-0000-0001",
    "amazonBuyerID": "amzn1.account.XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "amazonAccountName": "%83e%83X%83g%20%91%BE%98Y",
    "amazonMailAddress": "test%40example.com",
    "billingCountryCode": "",
    "billingCity": "",
    "billingCounty": "",
    "billingDistrict": "",
    "billingPostalCode": "",
    "billingStateOrRegion": "",
    "billingAddressLine1": "",
    "billingAddressLine2": "",
    "billingAddressLine3": "",
    "billingName": "",
    "billingPhoneNumber": "",
    "paymentDescriptor": ""
}
レスポンスパラメータ：正常系
ShippingCountryCode=JP&ShippingCity=&ShippingCounty=&ShippingDistrict=&ShippingPostalCode=150-0043&ShippingStateOrRegion=&ShippingAddressLine1=%93%B9%8C%BA%8D%E2%203-14-6&ShippingAddressLine2=%83q%83%85%81%5B%83%7D%83b%83N%83X%8Fa%92J%83r%83%8B&ShippingAddressLine3=&ShippingName=%83e%83X%83g%20%89%D4%8Eq&ShippingPhoneNumber=03-0000-0001&AmazonBuyerID=amzn1.account.XXXXXXXXXXXXXXXXXXXXXXXXXXXX&AmazonAccountName=%83e%83X%83g%20%91%BE%98Y&AmazonMailAddress=test%40example.com&BillingCountryCode=&BillingCity=&BillingCounty=&BillingDistrict=&BillingPostalCode=&BillingStateOrRegion=&BillingAddressLine1=&BillingAddressLine2=&BillingAddressLine3=&BillingName=&BillingPhoneNumber=&PaymentDescriptor=
レスポンスパラメータ：異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。
※idPass版にのみ対応しています。json版には対応しておりません。

リクエスト
ShopID 必須 半角英数13桁
ショップID
ShopPass 必須 半角英数64桁
ショップパスワード
OrderID 必須 半角英数記号27桁
オーダーID

加盟店様が取引を識別するための値を設定します。

PayType 必須 半角数字2桁
決済方法

38：Amazon Pay

URL
/payment/SearchTradeMulti.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=38
レスポンス
正常
Status 必須
現状態

UNPROCESSED：未決済
REQSUCCESS：要求成功
AUTHPROCESS：認証中
AUTH：仮売上
REQCAPTURE：即時売上受付
CAPTURE：即時売上
REQSALES：売上受付
SALES：実売上
CANCEL：キャンセル
REQRETURN：返品受付
RETURN：返品
REGISTER：利用承諾
END：利用承諾終了
PAYFAIL：決済失敗

ProcessDate 必須 半角数字14桁 固定
処理日時

yyyyMMddHHmmss書式

JobCd 必須
処理区分

AUTH：仮売上
SALES：実売上
CAPTURE：即時売上
CANCEL：キャンセル
RETURN：返品
CHANGE：金額変更
REGISTER：利用承諾
END：利用承諾終了

AccessID 必須 半角英数32桁 固定
取引ID
AccessPass 必須 半角英数32桁 固定
取引パスワード
Amount 必須 半角数字7桁
利用金額
Tax 必須 半角数字7桁
税送料

ClientField1 必須 全半角100バイト
加盟店自由項目1

ClientField2 必須 全半角100バイト
加盟店自由項目2

ClientField3 必須 全半角100バイト
加盟店自由項目3

PayType 必須 半角数字2桁
決済方法

38：Amazon Pay

AmazonOrderReferenceID 必須 半角英数19桁
AmazonオーダーリファレンスID

空欄を返却します。

AmazonBillingAgreementID 必須 半角英数19桁
AmazonビリングアグリーメントID

空欄を返却します。

AmazonPayCancelAmount 必須 半角数字7桁
キャンセル金額

キャンセル・返品した金額を返却します。

AmazonPayCancelTax 必須 半角数字7桁
キャンセル税送料金額

キャンセル・返品した税送料を返却します。

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
Status=CAPTURE&ProcessDate=20190213200436&JobCd=CAPTURE&AccessID=67ed6da3551771c9f592cd6f7a19a90c&AccessPass=0695cc5eb676f9e11ab6e432f3747941&Amount=1000&Tax=0&ClientField1=&ClientField2=&ClientField3=&PayType=38&AmazonOrderReferenceID=&AmazonBillingAgreementID=&AmazonPayCancelAmount=0&AmazonPayCancelTax=0
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001